Skip to content

Conversation

@Managor
Copy link
Member

@Managor Managor commented Nov 20, 2025

The variant with an underscore looks marginally more readable as was discussed in Matrix today.
Both are fine to use, but this should be the suggested variant.
Good exaple of why:
image
image

@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Nov 20, 2025
Copy link
Member

@acuteenvy acuteenvy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't say that the new syntax is more readable. Separating words makes sense, with numbers it just looks off to me. But maybe it's just me, if everyone agrees on this I won't try to change your mind.

@sebastiaanspeck
Copy link
Member

I wouldn't say that the new syntax is more readable. Separating words makes sense, with numbers it just looks off to me. But maybe it's just me, if everyone agrees on this I won't try to change your mind.

I share this opinion.

@Managor
Copy link
Member Author

Managor commented Nov 21, 2025

I'm very much on the fence myself. I'll wait for more comments to drop in this thread and decide based on how many votes style got.

@kbdharun
Copy link
Member

I personally think it's fine to not document a preference for this, leave previous placeholders as it is and decide on a case by case basis (i.e. aligning with upstream docs examples).

Also, my biggest concern is it will increase the character count of the examples making large examples (i.e. some AWS subcommands, etc) with multiple placeholders even larger to display.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Issues/PRs modifying the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants